<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Namespace: platform</title>

    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">

    <h1 class="page-title">Namespace: platform</h1>

    




<section>

<header>
    
        <h2>platform</h2>
        
    
</header>

<article>
    <div class="container-overview">
    
        
            <div class="description"><p>Platform.js
Copyright 2014-2018 Benjamin Tan
Copyright 2011-2013 John-David Dalton
Available under MIT license</p></div>
        

        


<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="lib_platform.js.html">lib/platform.js</a>, <a href="lib_platform.js.html#line1">line 1</a>
    </li></ul></dd>
    

    

    

    
</dl>


        
    
    </div>

    

    

    

    

    

    

    
        <h3 class="subsection-title">Members</h3>

        
            
<h4 class="name" id=".description"><span class="type-signature">(static) </span>description<span class="type-signature"> :string|null</span></h4>




<div class="description">
    <p>The platform description.</p>
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">string</span>
|

<span class="param-type">null</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="lib_platform.js.html">lib/platform.js</a>, <a href="lib_platform.js.html#line1047">line 1047</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
            
<h4 class="name" id=".layout"><span class="type-signature">(static) </span>layout<span class="type-signature"> :string|null</span></h4>




<div class="description">
    <p>The name of the browser's layout engine.</p>
<p>The list of common layout engines include:
&quot;Blink&quot;, &quot;EdgeHTML&quot;, &quot;Gecko&quot;, &quot;Trident&quot; and &quot;WebKit&quot;</p>
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">string</span>
|

<span class="param-type">null</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="lib_platform.js.html">lib/platform.js</a>, <a href="lib_platform.js.html#line1058">line 1058</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
            
<h4 class="name" id=".manufacturer"><span class="type-signature">(static) </span>manufacturer<span class="type-signature"> :string|null</span></h4>




<div class="description">
    <p>The name of the product's manufacturer.</p>
<p>The list of manufacturers include:
&quot;Apple&quot;, &quot;Archos&quot;, &quot;Amazon&quot;, &quot;Asus&quot;, &quot;Barnes &amp; Noble&quot;, &quot;BlackBerry&quot;,
&quot;Google&quot;, &quot;HP&quot;, &quot;HTC&quot;, &quot;LG&quot;, &quot;Microsoft&quot;, &quot;Motorola&quot;, &quot;Nintendo&quot;,
&quot;Nokia&quot;, &quot;Samsung&quot; and &quot;Sony&quot;</p>
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">string</span>
|

<span class="param-type">null</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="lib_platform.js.html">lib/platform.js</a>, <a href="lib_platform.js.html#line1071">line 1071</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
            
<h4 class="name" id=".name"><span class="type-signature">(static) </span>name<span class="type-signature"> :string|null</span></h4>




<div class="description">
    <p>The name of the browser/environment.</p>
<p>The list of common browser names include:
&quot;Chrome&quot;, &quot;Electron&quot;, &quot;Firefox&quot;, &quot;Firefox for iOS&quot;, &quot;IE&quot;,
&quot;Microsoft Edge&quot;, &quot;PhantomJS&quot;, &quot;Safari&quot;, &quot;SeaMonkey&quot;, &quot;Silk&quot;,
&quot;Opera Mini&quot; and &quot;Opera&quot;</p>
<p>Mobile versions of some browsers have &quot;Mobile&quot; appended to their name:
eg. &quot;Chrome Mobile&quot;, &quot;Firefox Mobile&quot;, &quot;IE Mobile&quot; and &quot;Opera Mobile&quot;</p>
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">string</span>
|

<span class="param-type">null</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="lib_platform.js.html">lib/platform.js</a>, <a href="lib_platform.js.html#line1087">line 1087</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
            
<h4 class="name" id=".os"><span class="type-signature">(static) </span>os<span class="type-signature"> :Object</span></h4>




<div class="description">
    <p>The name of the operating system.</p>
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Object</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="lib_platform.js.html">lib/platform.js</a>, <a href="lib_platform.js.html#line1132">line 1132</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
            
<h4 class="name" id=".platform"><span class="type-signature">(static) </span>platform<span class="type-signature"> :Object</span></h4>




<div class="description">
    <p>The platform object.</p>
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Object</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="lib_platform.js.html">lib/platform.js</a>, <a href="lib_platform.js.html#line1039">line 1039</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
            
<h4 class="name" id=".prerelease"><span class="type-signature">(static) </span>prerelease<span class="type-signature"> :string|null</span></h4>




<div class="description">
    <p>The alpha/beta release indicator.</p>
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">string</span>
|

<span class="param-type">null</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="lib_platform.js.html">lib/platform.js</a>, <a href="lib_platform.js.html#line1095">line 1095</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
            
<h4 class="name" id=".product"><span class="type-signature">(static) </span>product<span class="type-signature"> :string|null</span></h4>




<div class="description">
    <p>The name of the product hosting the browser.</p>
<p>The list of common products include:</p>
<p>&quot;BlackBerry&quot;, &quot;Galaxy S4&quot;, &quot;Lumia&quot;, &quot;iPad&quot;, &quot;iPod&quot;, &quot;iPhone&quot;, &quot;Kindle&quot;,
&quot;Kindle Fire&quot;, &quot;Nexus&quot;, &quot;Nook&quot;, &quot;PlayBook&quot;, &quot;TouchPad&quot; and &quot;Transformer&quot;</p>
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">string</span>
|

<span class="param-type">null</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="lib_platform.js.html">lib/platform.js</a>, <a href="lib_platform.js.html#line1108">line 1108</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
            
<h4 class="name" id=".toString"><span class="type-signature">(static) </span>toString<span class="type-signature"></span></h4>




<div class="description">
    <p>Returns <code>platform.description</code> when the platform object is coerced to a string.</p>
</div>







<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="lib_platform.js.html">lib/platform.js</a>, <a href="lib_platform.js.html#line604">line 604</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
            
<h4 class="name" id=".ua"><span class="type-signature">(static) </span>ua<span class="type-signature"> :string|null</span></h4>




<div class="description">
    <p>The browser's user agent string.</p>
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">string</span>
|

<span class="param-type">null</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="lib_platform.js.html">lib/platform.js</a>, <a href="lib_platform.js.html#line1116">line 1116</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
            
<h4 class="name" id=".version"><span class="type-signature">(static) </span>version<span class="type-signature"> :string|null</span></h4>




<div class="description">
    <p>The browser/environment version.</p>
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">string</span>
|

<span class="param-type">null</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="lib_platform.js.html">lib/platform.js</a>, <a href="lib_platform.js.html#line1124">line 1124</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
    

    
        <h3 class="subsection-title">Methods</h3>

        
            

    

    
    <h4 class="name" id=".parse"><span class="type-signature">(static) </span>parse<span class="signature">(ua<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Object}</span></h4>
    

    



<div class="description">
    <p>Creates a new platform object.</p>
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>ua</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>
|

<span class="param-type">string</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    navigator.userAgent
                
                </td>
            

            <td class="description last"><p>The user agent string or
context object.</p></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="lib_platform.js.html">lib/platform.js</a>, <a href="lib_platform.js.html#line254">line 254</a>
    </li></ul></dd>
    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    <p>A platform object.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Object</span>


    </dd>
</dl>

    





        
    

    

    
</article>

</section>




</div>

<nav>
    <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="beef.are.html">are</a></li><li><a href="beef.browser.html">browser</a></li><li><a href="beef.browser.cookie.html">cookie</a></li><li><a href="beef.browser.popup.html">popup</a></li><li><a href="beef.dom.html">dom</a></li><li><a href="beef.encode.base64.html">base64</a></li><li><a href="beef.encode.json.html">json</a></li><li><a href="beef.geolocation.html">geolocation</a></li><li><a href="beef.hardware.html">hardware</a></li><li><a href="beef.init.html">init</a></li><li><a href="beef.logger.html">logger</a></li><li><a href="beef.mitb.html">mitb</a></li><li><a href="beef.net.html">net</a></li><li><a href="beef.net.connection.html">connection</a></li><li><a href="beef.net.cors.html">cors</a></li><li><a href="beef.net.dns.html">dns</a></li><li><a href="beef.net.local.html">local</a></li><li><a href="beef.net.portscanner.html">portscanner</a></li><li><a href="beef.net.requester.html">requester</a></li><li><a href="beef.net.xssrays.html">xssrays</a></li><li><a href="beef.os.html">os</a></li><li><a href="beef.session.html">session</a></li><li><a href="beef.timeout.html">timeout</a></li><li><a href="beef.updater.html">updater</a></li><li><a href="beef.webrtc.html">webrtc</a></li><li><a href="beef.websocket.html">websocket</a></li><li><a href="BeefJS.html">BeefJS</a></li><li><a href="browser_jools.html">browser_jools</a></li><li><a href="platform.html">platform</a></li></ul>
</nav>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Thu Jan 02 2020 16:29:11 GMT+1000 (Australian Eastern Standard Time)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>